home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 18 / CU Amiga Magazine's Super CD-ROM 18 (1997)(EMAP Images)(GB)[!][issue 1998-01].iso / CUCD / Programming / AmigaE / Src / Utils / AgSplit / AGSplit.readme < prev   
Encoding:
Text File  |  1996-09-27  |  2.6 KB  |  81 lines
  1. Short: Intelligent AmigaGuide splitter
  2. Type: text/hyper
  3. Uploader: jason@fsel.com (Jason R. Hulance)
  4. Author: jason@fsel.com (Jason R. Hulance)
  5.  
  6. AGSplit
  7. =======
  8. AGSPlit is an intelligent AmigaGuide file splitter.  By "intelligent"
  9. I mean that each of the resulting pieces is a complete, stand-alone
  10. AmigaGuide file.  Needless to say, the pieces are all interlinked and
  11. behave as if they were in one big AmigaGuide file.
  12.  
  13. Why would you want to split an AmigaGuide file?  Well, the smaller the
  14. file is the faster it loads into AmigaGuide/Multiview.  The trade-off
  15. is that it is marginally slower to go between links that are not in
  16. the same AmigaGuide file (but this is hardly noticeable if the pieces
  17. are small!).
  18.  
  19. In particular, I wrote this program to split up my "Beginner's Guide
  20. to Amiga E" which I write in TeXinfo format and so produce using the
  21. excellent MakeGuide utility (and the version of MakeGuide I use can
  22. only make one large file).
  23.  
  24. Usage
  25. -----
  26. The template is:
  27.  
  28.   GUIDEFILE/A,SPLITFILE/A,DESTDIR
  29.  
  30. "GUIDEFILE" is the file to split.
  31. "SPLITFILE" is a short file to show the split positions (see below).
  32. "DESTDIR" is an optional directory name to store the pieces (default
  33.           is the current directory).
  34.  
  35. Split Files
  36. -----------
  37. A split file consists of node/filename pairs which describe the
  38. positions where the AmigaGuide file is to be split.  The nodes must be
  39. specified in the order in which they appear in the AmigaGuide file.
  40. For example:
  41.  
  42. Main
  43. Contents.guide
  44. FirstNode
  45. Chapter1.guide
  46. AnotherNode
  47. Appendix.guide
  48.  
  49. This split file specifies that *all* nodes from "Main" up to
  50. "FirstNode" (but not including "FirstNode") will be split into the
  51. file "Contents.guide".
  52.  
  53. All nodes from "FirstNode" up to "AnotherNode" (but not including
  54. "AnotherNode") will be split into "Chapter1.guide".
  55.  
  56. All nodes from "AnotherNode" to the end of the original AmigaGuide
  57. file will be split into "Appendix.guide".
  58.  
  59. If this split file were called "mysplitfile" and the AmigaGuide file
  60. to be split were called "myagfile.guide", then:
  61.  
  62.    AGSplit myagfile.guide mysplitfile ram:
  63.  
  64. would split "myagfile.guide" into the specified pieces
  65. ("Contents.guide", "Chapter1.guide" and "Appendix.guide") and put the
  66. pieces into the "ram:" directory.
  67.  
  68. Examples
  69. --------
  70. Two supplied example split files can be used to split my "Beginner's
  71. Guide to Amiga E" and the "E Reference Guide" (both available in the
  72. current Amiga E distribution in dev/e).
  73.  
  74. To Do
  75. -----
  76. I might make a better interface than "split files", but they are
  77. simple enough to use...
  78.  
  79. It's a bit slow at the moment (I'm using a quite general engine), but
  80. it's not something you'd do very often...
  81.